// <editor-fold defaultstate="collapsed" desc="GNU GPLv3 Header">
/*
 * File:   Chunk.java
 *
 * Copyright (C) 2013 Robert Antoni Buj Gelonch <rbuj@uoc.edu>
 * Copyright (C) 2013 David Megias Jimenez <dmegias@uoc.edu>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
// </editor-fold>
package uoc.libwave;

// <editor-fold defaultstate="collapsed" desc="imports">
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
// </editor-fold>

/**
 * Class for storing a generic WAVE chunk and, for reading and writing its
 * content in Data I/O Streams.
 *
 * @author Robert Antoni Buj Gelonch <rbuj@uoc.edu>
 * @version 1.0
 * @since 2013-08-04
 */
class Chunk extends LittleEndianBinaryFileOps {

    /**
     * ID of a generic chunk.
     */
    String ckID;
    /**
     * Byte number of a generic chunk.
     */
    int ckSize;

    /**
     *
     * @since 2013-08-04
     */
    Chunk() {
    }

    /**
     *
     * @param chunkID The id of the WAVE chunk
     * @param chunkSize The byte number of the WAVE chunk
     *
     * @since 2013-08-04
     */
    Chunk(String chunkID, int chunkSize) {
        ckID = chunkID;
        ckSize = chunkSize;
    }

    /**
     * Writes the ID of a generic chunk to a DataOutputStream.
     *
     * @param dos DataOutputStream that points correctly to the underlying output
     * stream for writing data.
     * @throws IOException if an output error occurs.
     *
     * @since 2013-08-04
     */
    protected void writeCkID(DataOutputStream dos) throws IOException {
        char[] ID = ckID.toCharArray();
        for (int i = 0; i < 4; i++) {
            writeAsciiCharLE(ID[i], dos);
        }
    }

    /**
     * Writes the size of a generic chunk to a DataOutputStream.
     *
     * @param dos DataOutputStream that points correctly to the underlying output
     * stream for writing data.
     * @throws IOException if an output error occurs.
     * 
     * @since 2013-08-04
     */
    protected void writeCkSize(DataOutputStream dos) throws IOException {
        writeLongLE(ckSize, dos);
    }

    /**
     * Gets the chunck size in bytes.
     *
     * @return The chunk size in bytes.
     *
     * @since 2013-08-07
     */
    protected int getCkSize() {
        return ckSize;
    }
}